/*
 * Copyright (C) 2010 Geometer Plus <contact@geometerplus.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

package org.geometerplus.zlibrary.core.network;

import java.io.IOException;
import java.io.InputStream;
import java.net.URLConnection;
import java.util.zip.GZIPInputStream;


public abstract class ZLNetworkRequest {

    public static final int AUTHENTICATION_NO_AUTH = 0;
    public static final int AUTHENTICATION_BASIC = 1;


    public final String URL;
    public final String SSLCertificate;

    public int AuthenticationMethod = AUTHENTICATION_NO_AUTH;
    public String UserName;
    public String Password;

    public boolean FollowRedirects = true;


    protected ZLNetworkRequest(String url) {
        this(url, null);
    }

    protected ZLNetworkRequest(String url, String sslCertificate) {
        URL = url;
        SSLCertificate = sslCertificate;
    }

    // callbacks return error messages
    public String doBefore() {
        return null;
    }

    String doHandleStream(URLConnection connection, InputStream inputStream) throws IOException {
        String encoding = connection.getContentEncoding();
        if (encoding != null) {
            encoding = encoding.toLowerCase();
            if (encoding.equals("gzip")) {
                inputStream = new GZIPInputStream(inputStream);
            }
        }
        return handleStream(connection, inputStream);
    }

    public abstract String handleStream(URLConnection connection, InputStream inputStream) throws IOException;

    public String doAfter(boolean success) { // returned error message is ignored when `success == false`
        return null;
    }
}
